API Explorer API Documentation

Basic Pages
List Methods
Expand Methods

GETIndex/sites/:site_slug/pages/basic_pages

Shows a list of the basic pages in the system

Parameter	Type	Location	Description
site_slug	string	query	the site holding the basic page
__token	string	query	pagination token
__nonce	string	query	pagination nonce
limit	int	query	maximum number of results to return

POSTCreate/sites/:site_slug/pages/basic_pages
Creates a basic page for a site
Parameter Value Type Location Description
site_slug string
query
the site holding the basic page
body json
query
a JSON representation of the new basic page
PUTUpdate/sites/:site_slug/pages/basic_pages/:id
Updates the attributes of a basic page
Parameter Value Type Location Description
site_slug string
query
the site holding the basic page
id int
query
the ID of the basic page
body json
query
JSON containing updates
DELETEDestroy/sites/:site_slug/pages/basic_pages/:id
Removes a basic page
Parameter Value Type Location Description
site_slug string
query
the site holding the basic page
id int
query
the ID of the basic page

Blog Posts
List Methods
Expand Methods

GETIndex/sites/:site_slug/pages/blogs/:id/posts

Shows a list of posts for a blog

Parameter	Type	Location	Description
site_slug	string	query	the site holding the blog
id	int	query	the ID of the blog
__token	string	query	pagination token
__nonce	string	query	pagination nonce
limit	int	query	maximum number of results to return

GETMatch/sites/:site_slug/pages/blogs/:id/match
Find a blog post by its external id
Parameter Value Type Location Description
site_slug string
query
the site holding the blog
id int
query
the ID of the blog
external_id int
query
the external id of the blog post
GETShow/sites/:site_slug/pages/blogs/:blog_id/posts/:blog_post_id
Show the details of a blog post
Parameter Value Type Location Description
site_slug string
query
the site holding the blog
blog_id int
query
the ID of the blog
blog_post_id int
query
the ID of the blog post
POSTCreate/sites/:site_slug/pages/blogs/:blog_id/posts
Creates a new blog post
Parameter Value Type Location Description
site_slug string
query
the site holding the blog
blog_id int
query
the ID of the blog
body json
query
a JSON representation of the new post
PUTUpdate/sites/:site_slug/pages/blogs/:blog_id/posts/:blog_post_id
Updates the attributes of a blog post
Parameter Value Type Location Description
site_slug string
query
the site holding the blog
blog_id int
query
the ID of the blog
blog_post_id int
query
the ID of the blog post
body json
query
JSON containing updates
DELETEDestroy/sites/:site_slug/pages/blogs/:blog_id/posts/:blog_post_id
Removes a blog post
Parameter Value Type Location Description
site_slug string
query
the site holding the blog
blog_id int
query
the ID of the blog
blog_post_id int
query
the ID of the blog post

Blogs
- List Methods
- Expand Methods
- GETIndex/sites/:site_slug/pages/blogs
  Shows a list of all blogs
  Parameter Value Type Location Description
  site_slug string
  query
  the site holding the blog
  __token string
  query
  pagination token
  __nonce string
  query
  pagination nonce
  limit int
  query
  maximum number of results to return
- GETShow/sites/:site_slug/pages/blogs/:id
  Show the details of a blog
  Parameter Value Type Location Description
  site_slug string
  query
  the site holding the blog
  id int
  query
  the ID of the blog
- POSTCreate/sites/:site_slug/pages/blogs
  Creates a new blog
  Parameter Value Type Location Description
  site_slug string
  query
  the site holding the blog
  body json
  query
  a JSON representation of the new blog
- PUTUpdate/sites/:site_slug/pages/blogs/:id
  Updates the attributes of a blog
  Parameter Value Type Location Description
  site_slug string
  query
  the site holding the blog
  id int
  query
  the ID of the blog
  body json
  query
  JSON containing updates
- DELETEDestroy/sites/:site_slug/pages/blogs/:id
  Removes a blog
  Parameter Value Type Location Description
  site_slug string
  query
  the site holding the blog
  id int
  query
  the ID of the blog

Calendars
List Methods
Expand Methods

GETIndex/sites/:site_slug/pages/calendars

Shows a list of calendars

Parameter	Type	Location	Description
site_slug	string	query	the site holding the calendars
__token	string	query	pagination token
__nonce	string	query	pagination nonce
limit	int	query	maximum number of results to return

GETShow/sites/:site_slug/pages/calendars/:id
Show the details of a calendar
Parameter Value Type Location Description
site_slug string
query
the site holding the calendar
id int
query
the ID of the calendar
POSTCreate/sites/:site_slug/pages/calendars
Creates a new calendar
Parameter Value Type Location Description
site_slug string
query
the site holding the calendar
body json
query
a JSON representation of the new calendar
PUTUpdate/sites/:site_slug/pages/calendars/:id
Updates the attributes of a calendar
Parameter Value Type Location Description
site_slug string
query
the site holding the calendar
id int
query
the ID of the calendar
body json
query
JSON containing updates
DELETEDestroy/sites/:site_slug/pages/calendars/:id
Removes a calendar
Parameter Value Type Location Description
site_slug string
query
the site holding the calendar
id int
query
the ID of the calendar

Campaign Data
- List Methods
- Expand Methods
- GETShow/campaign_data
  Shows campaign metadata about the nation
  Parameter Value Type Location Description
Contacts
- List Methods
- Expand Methods
- GETIndex/people/:person_id/contacts
  View a paginated list of a person's contacts
  Parameter Value Type Location Description
  person_id int
  query
  the person's ID
  __token string
  query
  pagination token
  __nonce string
  query
  pagination nonce
  limit int
  query
  maximum number of results to return
- POSTCreate/people/:person_id/contacts
  Record a contact for a person
  Parameter Value Type Location Description
  person_id int
  query
  the person's ID
  body json
  query
  a JSON representation of the new contact
Contact Types
- List Methods
- Expand Methods
- GETIndex/settings/contact_types
  Returns paginated list of nation-defined contact types
  Parameter Value Type Location Description
  __token string
  query
  pagination token
  __nonce string
  query
  pagination nonce
  limit int
  query
  maximum number of results to return
- POSTCreate/settings/contact_types
  Creates a new contact type
  Parameter Value Type Location Description
  body json
  query
  a JSON representation of the new contact type
- PUTUpdate/settings/contact_types/:id
  Updates an existing contact type
  Parameter Value Type Location Description
  id int
  query
  the ID of the existing contact type
  body json
  query
  a JSON representation of the updates to make
- DELETEDestroy/settings/contact_types/:id
  Destroys a contact type
  Parameter Value Type Location Description
  id int
  query
  the ID of the existing contact type
- GETList Methods/settings/contact_methods
  Lists all contact methods
  Parameter Value Type Location Description
- GETList Statuses/settings/contact_statuses
  Lists all contact status types
  Parameter Value Type Location Description

Parameter	Value	Type	Location	Description
site_slug		string	query	the site holding the calendar
id		int	query	the ID of the calendar

Parameter	Value	Type	Location	Description
site_slug		string	query	the site holding the calendar
body		json	query	a JSON representation of the new calendar

Parameter	Type	Location	Description
site_slug	string	query	the site holding the calendar
id	int	query	the ID of the calendar
body	json	query	JSON containing updates

Parameter	Value	Type	Location	Description
site_slug		string	query	the site holding the calendar
id		int	query	the ID of the calendar

Parameter	Type	Location	Description
person_id	int	query	the person's ID
__token	string	query	pagination token
__nonce	string	query	pagination nonce
limit	int	query	maximum number of results to return

Parameter	Value	Type	Location	Description
person_id		int	query	the person's ID
body		json	query	a JSON representation of the new contact

Parameter	Type	Location	Description
__token	string	query	pagination token
__nonce	string	query	pagination nonce
limit	int	query	maximum number of results to return

Parameter	Value	Type	Location	Description
body		json	query	a JSON representation of the new contact type

Parameter	Value	Type	Location	Description
id		int	query	the ID of the existing contact type
body		json	query	a JSON representation of the updates to make

Parameter	Value	Type	Location	Description
id		int	query	the ID of the existing contact type

Donations
List Methods
Expand Methods

GETIndex/donations
Returns a list of donations
Parameter Value Type Location Description
__token string
query
pagination token
__nonce string
query
pagination nonce
limit int
query
maximum number of results to return

Parameter	Type	Location	Description
__token	string	query	pagination token
__nonce	string	query	pagination nonce
limit	int	query	maximum number of results to return

GETSearch/donations/search

Search for donations with provided attributes

Parameter	Type	Location	Description
created_since	string	query	No description
succeeded_since	string	query	No description
failed_since	string	query	No description
__token	string	query	pagination token
__nonce	string	query	pagination nonce
limit	int	query	maximum number of results to return

POSTCreate/donations
Creates a donation with the provided data
Parameter Value Type Location Description
body json
query
a JSON representation of a donation
PUTUpdate/donations/:id
Updates a donation with the provided data
Parameter Value Type Location Description
id int
query
the donation's ID
body json
query
JSON attributes for updating the donation
DELETEDestroy/donations/:id
Removes the donation with the matching ID
Parameter Value Type Location Description
id int
query
the donation's ID

Parameter	Value	Type	Location	Description
body		json	query	a JSON representation of a donation

Parameter	Value	Type	Location	Description
id		int	query	the donation's ID
body		json	query	JSON attributes for updating the donation

Parameter	Value	Type	Location	Description
id		int	query	the donation's ID

Events
List Methods
Expand Methods

GETIndex/sites/:site_slug/pages/events

Returns a list of events

Parameter	Type	Location	Description
site_slug	string	query	the site holding the event
__token	string	query	pagination token
__nonce	string	query	pagination nonce
limit	int	query	maximum number of results to return
tags	string	query	tags that must be present on the event
starting	string	query	earliest starting time
until	string	query	latest ending time
calendar_id	int	query	the ID of the calendar from which events should be scoped

GETShow/sites/:site_slug/pages/events/:id
Returns an event
Parameter Value Type Location Description
site_slug string
query
the site holding the event
id int
query
the event's ID
POSTCreate/sites/:site_slug/pages/events
Creates a event with the provided data
Parameter Value Type Location Description
site_slug string
query
the site holding the event
body json
query
JSON representation of a event
PUTUpdate/sites/:site_slug/pages/events/:id
Updates a event with the provided data
Parameter Value Type Location Description
site_slug string
query
the site holding the event
id int
query
the event's ID
body json
query
JSON attributes for updating the event
DELETEDestroy/sites/:site_slug/pages/events/:id
Removes the event with the matching ID
Parameter Value Type Location Description
site_slug string
query
the site holding the event
id int
query
the event's ID

GETRSVPs/sites/:site_slug/pages/events/:id/rsvps

Lists all RSVPs for an event

Parameter	Type	Location	Description
site_slug	string	query	the site holding the event
id	int	query	the event's ID
__token	string	query	pagination token
__nonce	string	query	pagination nonce
limit	int	query	maximum number of results to return

POSTRSVP Create/sites/:site_slug/pages/events/:id/rsvps
Creates an RSVP for an event
Parameter Value Type Location Description
site_slug string
query
the site holding the event
id int
query
the event's ID
body json
query
A JSON representation of the new post
PUTRSVP Update/sites/:site_slug/pages/events/:event_id/rsvps/:rsvp_id
Updates an existing RSVP
Parameter Value Type Location Description
site_slug string
query
the site holding the event
event_id int
query
the event's ID
rsvp_id int
query
the RSVP's ID
body json
query
JSON attributes for updating the RSVP

Imports
- List Methods
- Expand Methods
- GETShow/imports/:id
  Shows the status of an import
  Parameter Value Type Location Description
  id int
  query
  the ID of the import
- POSTCreate/imports
  Creates a import with the provided data
  Parameter Value Type Location Description
  body json
  query
  JSON representation of the import
- GETResult/imports/:id/result
  Gets the import results and error csv file.
  Parameter Value Type Location Description
  id int
  query
  the ID of the import
Exports
- List Methods
- Expand Methods
- POSTExport List/lists/:list_id/exports
  Starts an export of a list
  Parameter Value Type Location Description
  list_id int
  query
  ID of the list to export
  body json
  query
  JSON representation of the export
- GETShow/exports/:id
  Shows the status of a list export.
  Parameter Value Type Location Description
  id int
  query
  the ID of the export
- DELETEDelete/exports/:id
  Delete the export
  Parameter Value Type Location Description
  id int
  query
  the ID of the export
Lists
- List Methods
- Expand Methods
- GETIndex/lists
  Returns a list of created custom lists
  Parameter Value Type Location Description
  __token string
  query
  pagination token
  __nonce string
  query
  pagination nonce
  limit int
  query
  maximum number of results to return
- GETPeople/lists/:id/people
  Returns people stored in a list
  Parameter Value Type Location Description
  id int
  query
  the list's ID
  __token string
  query
  pagination token
  __nonce string
  query
  pagination nonce
  limit int
  query
  maximum number of results to return
- POSTCreate/lists
  Creates a list with the provided data
  Parameter Value Type Location Description
  body json
  query
  a JSON representation of the list to create
- PUTUpdate/lists/:id
  Updates a list with the provided data
  Parameter Value Type Location Description
  id int
  query
  the list's ID
  body json
  query
  JSON attributes for updating the list
- DELETEDestroy/lists/:id
  Removes the list with the matching ID
  Parameter Value Type Location Description
  id int
  query
  the list's ID
- POSTAdd people/lists/:list_id/people
  Adds people to a list
  Parameter Value Type Location Description
  list_id int
  query
  the list's ID
  body json
  query
  A JSON hash containing the people to add to the list
- DELETEDestroy people/lists/:list_id/people
  Removes people from a list
  Parameter Value Type Location Description
  list_id int
  query
  the list's ID
  body json
  query
  A JSON hash containing the people to remove from the list
- POSTListing Create (deprecated)/lists/:list_id/listings
  Adds a person to a list
  Parameter Value Type Location Description
  list_id int
  query
  the list's ID
  person_id int
  query
  the ID of the person to add to the list
- DELETEListing Deletion (deprecated)/lists/:list_id/listings/:person_id
  Drops a person from a list
  Parameter Value Type Location Description
  list_id int
  query
  the list's ID
  person_id int
  query
  the ID of the person to drop from the list
- POSTAdd tag/lists/:list_id/tag/:tag
  Adds a tag to all of the list members
  Parameter Value Type Location Description
  list_id int
  query
  the list's ID
  tag string
  query
  the name of the tag to use
- DELETEDelete tag/lists/:list_id/tag/:tag
  Deletes the tag from all of the list members
  Parameter Value Type Location Description
  list_id int
  query
  the list's ID
  tag string
  query
  the name of the tag to use
Memberships
- List Methods
- Expand Methods
- GETIndex/people/:person_id/memberships
  Lists all memberships for a person
  Parameter Value Type Location Description
  person_id int
  query
  the person's ID
  __token string
  query
  pagination token
  __nonce string
  query
  pagination nonce
  limit int
  query
  maximum number of results to return
- POSTCreate/people/:person_id/memberships
  Creates a membership
  Parameter Value Type Location Description
  person_id int
  query
  the person's ID
  body json
  query
  JSON attributes for the new membership
- PUTUpdate/people/:person_id/memberships
  Updates a membership
  Parameter Value Type Location Description
  person_id int
  query
  the person's ID
  body json
  query
  JSON attributes for updating a membership
- DELETEDestroy/people/:person_id/memberships/:name
  Removes a membership from the person
  Parameter Value Type Location Description
  person_id int
  query
  the person's ID
  name string
  query
  the name of the membership

Parameter	Value	Type	Location	Description
id		int	query	the ID of the import

Parameter	Value	Type	Location	Description
body		json	query	JSON representation of the import

Parameter	Value	Type	Location	Description
id		int	query	the ID of the import

Parameter	Value	Type	Location	Description
list_id		int	query	ID of the list to export
body		json	query	JSON representation of the export

Parameter	Value	Type	Location	Description
id		int	query	the ID of the export

Parameter	Value	Type	Location	Description
id		int	query	the ID of the export

Parameter	Type	Location	Description
__token	string	query	pagination token
__nonce	string	query	pagination nonce
limit	int	query	maximum number of results to return

Parameter	Type	Location	Description
id	int	query	the list's ID
__token	string	query	pagination token
__nonce	string	query	pagination nonce
limit	int	query	maximum number of results to return

Page Attachments
List Methods
Expand Methods

GETIndex/sites/:site_slug/pages/:page_slug/attachments

Returns a list of a page's file attachments

Parameter	Type	Location	Description
site_slug	string	query	the slug of the site the page lives on
page_slug	string	query	the page's slug
__token	string	query	pagination token
__nonce	string	query	pagination nonce
limit	int	query	maximum number of results to return

GETShow/sites/:site_slug/pages/:page_slug/attachments/:id
Returns the details of the file attachment for a page
Parameter Value Type Location Description
site_slug string
query
the slug of the site the page lives on
page_slug string
query
the page's slug
id int
query
the ID of the page attachment
POSTCreate/sites/:site_slug/pages/:page_slug/attachments
Creates a new file attachment for a page
Parameter Value Type Location Description
site_slug string
query
the slug of the site the page lives on
page_slug string
query
the page's slug
body json
query
a JSON representation of the attachment
DELETEDestroy/sites/:site_slug/pages/:page_slug/attachments/:id
Destroys a file attachment for a page
Parameter Value Type Location Description
site_slug string
query
the slug of the site the page lives on
page_slug string
query
the page's slug
id int
query
the ID of the page attachment

Paths
- List Methods
- Expand Methods
- GETIndex/paths
  Returns a list of paths and path steps
  Parameter Value Type Location Description
  __token string
  query
  pagination token
  __nonce string
  query
  pagination nonce
  limit int
  query
  maximum number of results to return

People
List Methods
Expand Methods

GETIndex/people
Returns a list of people
Parameter Value Type Location Description
__token string
query
pagination token
__nonce string
query
pagination nonce
limit int
query
maximum number of results to return
GETCount/people/count
Returns a count of people in the nation
Parameter Value Type Location Description
GETShow/people/:id
Returns a full representation of the person
Parameter Value Type Location Description
id int
query
the person's id
GETMatch/people/match
Finds people that match certain attributes exactly
Parameter Value Type Location Description
email string
query
No description
first_name string
query
deprecated
last_name string
query
deprecated
phone string
query
deprecated
mobile string
query
deprecated

GETSearch/people/search

Search for people using non-unique traits

Parameter	Type	Location	Description
first_name	string	query	No description
last_name	string	query	No description
city	string	query	No description
state	string	query	No description
sex	string	query	No description
birthdate	string	query	No description
updated_since	string	query	No description
with_mobile	string	query	No description
custom_values	string	query	No description
civicrm_id	string	query	No description
county_file_id	string	query	No description
datatrust_id	string	query	No description
dw_id	string	query	No description
external_id	string	query	No description
media_market_id	string	query	No description
membership_level_id	string	query	No description
ngp_id	string	query	No description
pf_strat_id	string	query	No description
rnc_id	string	query	No description
rnc_regid	string	query	No description
salesforce_id	string	query	No description
state_file_id	string	query	No description
van_id	string	query	No description
__token	string	query	pagination token
__nonce	string	query	pagination nonce
limit	int	query	maximum number of results to return

GETNearby/people/nearby

Searches for people near a location defined by latitude and longitude

Parameter	Type	Location	Description
location	string	query	origin of search in the format 'latitude,longitude'
distance	int	query	radius in miles for which to include results
__token	string	query	pagination token
__nonce	string	query	pagination nonce
limit	int	query	maximum number of results to return

GETMe/people/me
Returns the access token's resource owner's representation
Parameter Value Type Location Description
GETRegister/people/:id/register
Starts user registration person for the given person
Parameter Value Type Location Description
id int
query
the person's id
GETTaggings/people/:id/taggings
Returns all taggings for a given person
Parameter Value Type Location Description
id int
query
the person's id
PUTTag Person/people/:id/taggings
Tags a person
Parameter Value Type Location Description
id int
query
the person's id
body json
query
JSON with tagging information
DELETETag Removal/people/:id/taggings/:tag
Removes a tag from a person
Parameter Value Type Location Description
id int
query
the person's ID
tag string
query
the name of the tag
DELETEBulk Tag Removal/people/:id/taggings
Removes tags from a person
Parameter Value Type Location Description
id int
query
the person's ID
body json
query
the tagging resource
GETPolitical Capital/people/:id/capitals
Returns a paginated list of a person's capitals
Parameter Value Type Location Description
id int
query
the person's ID
__token string
query
pagination token
__nonce string
query
pagination nonce
limit int
query
maximum number of results to return
POSTPolitical Capital Create/people/:id/capitals
Creates capital for the given person
Parameter Value Type Location Description
id int
query
the person's ID
body json
query
JSON representation of the capital to create
DELETEPolitical Capital Destroy/people/:person_id/capitals/:capital_id
Destroys capital for a person
Parameter Value Type Location Description
person_id int
query
the person's ID
capital_id int
query
the ID of the capital to destroy
POSTCreate/people
Creates a person with the provided data
Parameter Value Type Location Description
body json
query
a JSON representation of the person to create
PUTUpdate/people/:id
Updates a person with the provided data
Parameter Value Type Location Description
id int
query
the person's ID
body json
query
JSON attributes for updating the person
PUTPush/people/push
Updates a matched person or creates a new one if the person doesn't exist
Parameter Value Type Location Description
body json
query
JSON attributes for updating/matching the person
PUTAdd/people/add
Updates a matched person (without overriding data) or creates a new one if the person doesn't exist
Parameter Value Type Location Description
body json
query
JSON attributes for updating/matching the person
DELETEDestroy/people/:id
Removes the person with the matching ID
Parameter Value Type Location Description
id int
query
the person's ID
POSTPrivate Note Create/people/:id/notes
Creates a private note for the given person
Parameter Value Type Location Description
id int
query
the person's ID
body json
query
a JSON representation of the note to create

People Tags
- List Methods
- Expand Methods
- GETIndex/tags
  Returns a list of previously used tags
  Parameter Value Type Location Description
  __token string
  query
  pagination token
  __nonce string
  query
  pagination nonce
  limit int
  query
  maximum number of results to return
- GETPeople/tags/:tag/people
  Searches for people with the given tag
  Parameter Value Type Location Description
  tag string
  query
  the name of the tag
  __token string
  query
  pagination token
  __nonce string
  query
  pagination nonce
  limit int
  query
  maximum number of results to return

Petitions
List Methods
Expand Methods

GETIndex/sites/:site_slug/pages/petitions

Returns the list of petitions in the site

Parameter	Type	Location	Description
site_slug	string	query	The site holding the petitions
__token	string	query	pagination token
__nonce	string	query	pagination nonce
limit	int	query	maximum number of results to return

GETShow/sites/:site_slug/pages/petitions/:id
Returns data for a single petition
Parameter Value Type Location Description
site_slug string
query
The site holding the petition
id int
query
The id of the petition
POSTCreate/sites/:site_slug/pages/petitions
Creates a new petition
Parameter Value Type Location Description
site_slug string
query
The site holding the petition
body json
query
JSON representation of the new petition
PUTUpdate/sites/:site_slug/pages/petitions/:id
Updates a single petition
Parameter Value Type Location Description
site_slug string
query
The site holding the petition
id int
query
The id of the petition
body json
query
JSON containing updates
DELETEDestroy/sites/:site_slug/pages/petitions/:id
Removes a petition
Parameter Value Type Location Description
site_slug string
query
The site holding the petition
id int
query
The id of the petition

GETSignatures Index/sites/:site_slug/pages/petitions/:petition_id/signatures

Returns list of signatures in a petition

Parameter	Type	Location	Description
site_slug	string	query	The site holding the petition
petition_id	int	query	The id of the petition
__token	string	query	pagination token
__nonce	string	query	pagination nonce
limit	int	query	maximum number of results to return

GETShow Signature/sites/:site_slug/pages/petitions/:petition_id/signatures/:id
Returns the signature
Parameter Value Type Location Description
site_slug string
query
The site holding the petition
petition_id int
query
The id of the petition
id int
query
The id of the signature
POSTCreate Signature/sites/:site_slug/pages/petitions/:petition_id/signatures
Creates a new signature for a petition
Parameter Value Type Location Description
site_slug string
query
The site holding the petition
petition_id int
query
The id of the petition
body json
query
JSON representation of the new signature

POSTUpdate Signature/sites/:site_slug/pages/petitions/:petition_id/signatures/:id

Updates a signature for a petition

Parameter	Type	Location	Description
site_slug	string	query	The site holding the petition
petition_id	int	query	The id of the petition
id	int	query	The id of the signature
body	json	query	JSON representation of the new signature

DELETEDestroy Signature/sites/:site_slug/pages/petitions/:petition_id/signatures/:id
Removes signature from petition
Parameter Value Type Location Description
site_slug string
query
The site holding the petition
petition_id int
query
The id of the petition
id int
query
The id of the signature

Precincts
- List Methods
- Expand Methods
- GETIndex/precincts
  Returns a list of current precincts
  Parameter Value Type Location Description
  __token string
  query
  pagination token
  __nonce string
  query
  pagination nonce
  limit int
  query
  maximum number of results to return
- GETShow/precincts/:id
  Returns a representation of the precinct
  Parameter Value Type Location Description
  id int
  query
  the precinct's ID
- POSTCreate/precincts
  Creates a precinct with the provided data
  Parameter Value Type Location Description
  body json
  query
  a JSON representation of the precinct to create
- PUTUpdate/precincts/:id
  Updates a precinct with the provided data
  Parameter Value Type Location Description
  id int
  query
  the precinct's ID
  body json
  query
  JSON attributes for updating the precinct
- DELETEDestroy/precincts/:id
  Removes the precinct with the matching ID
  Parameter Value Type Location Description
  id int
  query
  the precinct's ID
Sites
- List Methods
- Expand Methods
- GETIndex/sites
  Returns a list of all sites
  Parameter Value Type Location Description
  __token string
  query
  pagination token
  __nonce string
  query
  pagination nonce
  limit int
  query
  maximum number of results to return

Survey Responses
List Methods
Expand Methods

GETIndex/survey_responses

Lists all survey responses

Parameter	Type	Location	Description
start_time	string	query	the starting time for results
end_time	string	query	the ending time for results
survey_id	int	query	the ID for a parent survey
__token	string	query	pagination token
__nonce	string	query	pagination nonce
limit	int	query	maximum number of results to return

POSTCreate/survey_responses
Creates responses for a survey
Parameter Value Type Location Description
body json
query
a JSON representation of the survey responses

Surveys
- List Methods
- Expand Methods
- GETIndex/sites/:site_slug/pages/surveys
  Shows a list of all surveys for the a site
  Parameter Value Type Location Description
  site_slug string
  query
  the site holding the survey
  __token string
  query
  pagination token
  __nonce string
  query
  pagination nonce
  limit int
  query
  maximum number of results to return
- POSTCreate/sites/:site_slug/pages/surveys
  Creates a survey for a site
  Parameter Value Type Location Description
  site_slug string
  query
  the site holding the survey
  body json
  query
  A JSON representation of the new survey
- PUTUpdate/sites/:site_slug/pages/surveys/:id
  Updates the attributes of a survey
  Parameter Value Type Location Description
  site_slug string
  query
  the site holding the survey
  id int
  query
  the ID of the survey
  body json
  query
  JSON containing updates
- DELETEDestroy/sites/:site_slug/pages/surveys/:id
  Removes a survey
  Parameter Value Type Location Description
  site_slug string
  query
  the site holding the survey
  id int
  query
  the ID of the survey

API Explorer

Basic Pages
List Methods
Expand Methods

Blog Posts
List Methods
Expand Methods

Blogs
List Methods
Expand Methods

Calendars
List Methods
Expand Methods

Campaign Data
List Methods
Expand Methods

Contacts
List Methods
Expand Methods

Contact Types
List Methods
Expand Methods

Donations
List Methods
Expand Methods

Events
List Methods
Expand Methods

Imports
List Methods
Expand Methods

Exports
List Methods
Expand Methods

Lists
List Methods
Expand Methods

Memberships
List Methods
Expand Methods

Page Attachments
List Methods
Expand Methods

Paths
List Methods
Expand Methods

People
List Methods
Expand Methods

People Tags
List Methods
Expand Methods

Petitions
List Methods
Expand Methods

Precincts
List Methods
Expand Methods

Sites
List Methods
Expand Methods

Survey Responses
List Methods
Expand Methods

Surveys
List Methods
Expand Methods

Parameter	Type	Location	Description
email	string	query	No description
first_name	string	query	deprecated
last_name	string	query	deprecated
phone	string	query	deprecated
mobile	string	query	deprecated

Parameter	Type	Location	Description
tag	string	query	the name of the tag
__token	string	query	pagination token
__nonce	string	query	pagination nonce
limit	int	query	maximum number of results to return

Parameter	Value	Type	Location	Description
id		int	query	the precinct's ID
body		json	query	JSON attributes for updating the precinct